////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2001-2021 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING.  If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////

#if ! defined (octave_pt_bp_h)
#define octave_pt_bp_h 1

#include "octave-config.h"

#include "input.h"
#include "ov-usr-fcn.h"
#include "pt-walk.h"
#include "pt-pr-code.h"
#include "interpreter.h"

namespace octave
{
  class tree;
  class tree_decl_command;

  class tree_breakpoint : public tree_walker
  {
  public:

    enum action { set = 1, clear = 2, list = 3 };

    tree_breakpoint (int l, action a, const std::string& c = "")
      : m_line (l), m_action (a), m_condition (c), m_found (false),
        m_bp_list (), m_bp_cond_list ()
    { }

    // No copying!

    tree_breakpoint (const tree_breakpoint&) = delete;

    tree_breakpoint& operator = (const tree_breakpoint&) = delete;

    ~tree_breakpoint (void) = default;

    bool success (void) const { return m_found; }

    void visit_argument_list (tree_argument_list&);

    void visit_arguments_block (tree_arguments_block&);

    void visit_args_block_attribute_list (tree_args_block_attribute_list&);

    void visit_args_block_validation_list (tree_args_block_validation_list&);

    void visit_arg_validation (tree_arg_validation&);

    void visit_arg_size_spec (tree_arg_size_spec&);

    void visit_arg_validation_fcns (tree_arg_validation_fcns&);

    void visit_binary_expression (tree_binary_expression&);

    void visit_break_command (tree_break_command&);

    void visit_colon_expression (tree_colon_expression&);

    void visit_continue_command (tree_continue_command&);

    void visit_decl_command (tree_decl_command&);

    void visit_decl_init_list (tree_decl_init_list&);

    void visit_decl_elt (tree_decl_elt&);

    void visit_while_command (tree_while_command&);

    void visit_do_until_command (tree_do_until_command&);

    void visit_simple_for_command (tree_simple_for_command&);

    void visit_complex_for_command (tree_complex_for_command&);

    void visit_octave_user_function_header (octave_user_function&);

    void visit_octave_user_function_trailer (octave_user_function&);


    void visit_identifier (tree_identifier&);

    void visit_if_clause (tree_if_clause&);

    void visit_if_command_list (tree_if_command_list&);

    void visit_index_expression (tree_index_expression&);

    void visit_matrix (tree_matrix&);

    void visit_cell (tree_cell&);

    void visit_multi_assignment (tree_multi_assignment&);

    void visit_no_op_command (tree_no_op_command&);

    void visit_anon_fcn_handle (tree_anon_fcn_handle&);

    void visit_constant (tree_constant&);

    void visit_fcn_handle (tree_fcn_handle&);

    void visit_parameter_list (tree_parameter_list&);

    void visit_postfix_expression (tree_postfix_expression&);

    void visit_prefix_expression (tree_prefix_expression&);

    void visit_return_command (tree_return_command&);

    void visit_simple_assignment (tree_simple_assignment&);

    void visit_statement (tree_statement&);

    void visit_statement_list (tree_statement_list&);

    void visit_switch_case (tree_switch_case&);

    void visit_switch_case_list (tree_switch_case_list&);

    void visit_switch_command (tree_switch_command&);

    void visit_try_catch_command (tree_try_catch_command&);

    void visit_unwind_protect_command (tree_unwind_protect_command&);

    octave_value_list get_list (void) { return m_bp_list; }

    octave_value_list get_cond_list (void) { return m_bp_cond_list; }

    int get_line (void) { return m_found ? m_line : 0; }

  private:

    void take_action (tree& tr);

    void take_action (tree_statement& stmt);

    // Statement line number we are looking for.
    int m_line;

    // What to do.
    action m_action;

    // Expression which must be true to break
    std::string m_condition;

    // Have we already found the line?
    bool m_found;

    // List of breakpoint line numbers.
    octave_value_list m_bp_list;

    // List of breakpoint conditions.
    octave_value_list m_bp_cond_list;
  };
}

#endif
